home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / misc / xref_v1.1.lha / XRef / Doc / english / aguidexrefv39.doc < prev    next >
Encoding:
Text File  |  1995-01-09  |  5.6 KB  |  161 lines
  1. XRef-Tools/AGuideXRefV39                               XRef-Tools/AGuideXRefV39
  2.  
  3. $VER: aguidexrefv39.doc 1.12 (02.11.94)
  4.  
  5. NAME
  6.     AGuideXRefV39 - searches the xref-lists for a given string/pattern and
  7.                     shows a amigaguide text for the found entries
  8.  
  9. TEMPLATE
  10.     STRING,CATEGORY,FILE/K,CACHEDIR/K,LINELENGTH/N/K,COLUMNS/N/K,LIMIT/N/K,
  11.     NOPATTERN/S,NOCASE/S,PUBSCREEN/K,PORTNAME/K,FONTNAME/K,FONTSIZE/N/K
  12.  
  13. FORMAT
  14.     AGuideXRefV39 [[STRING (strg|pat)] [[CATEGORY] category] [FILE xreffile]
  15.                [CACHEDIR dir] [LINELENGTH numchars] [COLUMNS numcolumns]
  16.                [LIMIT maxentries] [NOPATTERN] [NOCASE] [PUBSCREEN pubname]
  17.                [PORTNAME agarexxport] [FONTNAME name.font] [FONTSIZE ysize]
  18.  
  19. FUNCTION
  20.     this command gives an CLI interface to the xref.library, which uses the
  21.     AmigaGuide system to display some found xref entries and have a link to
  22.     its real documentation.
  23.     If you specify the CACHEDIR, this directory will be used to save the
  24.     AmigaGuide files, if there are more the one entries for the given string
  25.     or pattern. Any next call with this CACHEDIR and the given string/pattern,
  26.     it will no longer call the xref.library function, but uses this file.
  27.     If you do not specify a CATEGORY all xreffiles in the xref.library are
  28.     parsed.From xref.library 1.8 the categorystring can be a pattern !
  29.  
  30.     New Gadgets
  31.     -----------
  32.  
  33.     AGuideXRefV39 has three additional gadgets, which allow direct access to
  34.     the xref.library.
  35.     
  36.     Category-Gadget :
  37.         The first string gadget is the category gadget. You can specify here
  38.         the category (pattern), you would search for.
  39.     String-Gadget :
  40.         The next string gadget is the string/pattern gadget. Enter here the
  41.         string/pattern you search for and press return to start the search.
  42.     SearchMode-Gadget:
  43.         The last gadget is a cycle gadget, which you can use to adjust the
  44.         search mode.
  45.  
  46.     Keycontrol
  47.     ----------
  48.  
  49.     The window has full keycontrol :
  50.         - Cursor keys work like in AmigaGuide (scroll through the document)
  51.         - Slash '/' key retrace to the last document
  52.         - '>' browse to the next document
  53.         - '<' browse to the previous document
  54.         - Tab select next field
  55.         - Shift Tab select previous field
  56.         - Return activate selected field document
  57.         - Space ' ' activate Table of Contents
  58.         - 'I','i' activate Index document
  59.         - 'P','p','S','s' activate string/pattern gadget
  60.         - 'C','c' activate category gadget
  61.  
  62. INPUTS
  63.     STRING (STRING) - string|pattern to search for
  64.  
  65.     CATEGORY (STRING) - category to parse (no specified category matches
  66.         all categories). Can be a pattern !
  67.  
  68.     FILE (STRING) - file to parse, this argument overrides the CATEGORY
  69.         argument
  70.  
  71.     CACHEDIR (STRING) - if you want to save all generated AmigaGuide files
  72.         to have a fast access to it, just specify here the directory, in which
  73.         these files will saved
  74.  
  75.     LIMIT (NUMBER) - specifies the maximal number of entries to match
  76.         (default : xref.library default (XREFBA_DefaultLimit))
  77.  
  78.     LINELENGTH (NUMBER) - specifies the number of chars for a line
  79.         (default : xref.library default (XREFBA_LineLength))
  80.  
  81.     COLUMNS (NUMBER) - specifies the number of columns, which will be used
  82.         if more than one entry matches
  83.         (default : xref.library default (XREFBA_Columns))
  84.  
  85.     NOPATTERN (BOOLEAN) - interprets the given string as a normal string
  86.         instead of a pattern
  87.  
  88.     NOCASE (BOOLEAN) - makes the search case-insensitive
  89.  
  90.     PUBSCREEN (STRING) - specifies the screen, on which the AmigaGuide winodw
  91.         should be opened
  92.  
  93.     PORTNAME (STRING) - arexxportname for the amigaguide.datatype process
  94.  
  95.     FONTNAME (STRING) - font to use for the document
  96.  
  97.     FONTSIZE (NUMBER) - font ysize to use for the document
  98.  
  99. EXAMPLES
  100.     The following example searches all xreffiles of the AutoDoc category for
  101.     xrefentries with the word "Window" inside and tries to open a window on
  102.     the
  103.     GoldEd Screen, if it has found some entry matches this pattern :
  104.  
  105.         AGuideXRefV39 #?Window#? #?AutoDoc#? PUBSCREEN=GOLDED.1
  106.  
  107. SEE ALSO
  108.     LoadXRef, ExpungeXRef, MakeXRef, ParseXRef, dos.library/ParsePattern()
  109.  
  110. COPYRIGHT
  111.     by Stefan Ruppert (C) 1994
  112.  
  113. HISTORY
  114.     AGuideXRefV39 1.12 (2.11.94) :
  115.         - used ReplyMsg() instead of GT_ReplyIMsg(). This is now fixed !
  116.  
  117.     AGuideXRefV39 1.11 (22.9.94) :
  118.         - ENTRYA_NodeName wasn't used for opening the guide. This is fixed !
  119.  
  120.     AGuideXRefV39 1.10 (8.9.94) :
  121.         - workbench support added
  122.  
  123.     AGuideXRefV39 1.9 (3.9.94) :
  124.         - some changes to reflect the xref.library v1.13 changes
  125.         - insertbyname() insertion order fixed
  126.  
  127.     AGuideXRefV39 1.8 (27.8.94) :
  128.         - line offsets are handled right
  129.         - screenfont usage changes (don't worded before with proportional
  130.           fonts ! Found and fixed by Marius Gröger)
  131.         - now use GM_LAYOUT method after new font selection
  132.  
  133.     AGuideXRefV39 1.7 (10.8.94) :
  134.         - now V37 and V39 are two programs
  135.         - menu added
  136.         - ' ' - key shows Table of Contents
  137.         - 'I' - key shows Index
  138.         - prefs file
  139.  
  140.     AGuideXRef 1.6 (29.7.94) :
  141.         - major changes for V39 version
  142.         - entries now sorted to files
  143.  
  144.     AGuideXRef 1.5 (10.6.94) :
  145.         - File highlighted added
  146.  
  147.     AGuideXRef 1.4 (5.6.94) :
  148.         - now unique tempfiles
  149.         - V39 datatype skeleton
  150.         - V39 datatype entry with the FORCEV39 switch
  151.  
  152.     AGuideXRef 1.3 (28.5.94) :
  153.         - CACHEDIR and PORTNAME options added
  154.  
  155.     AGuideXRef 1.2 (20.5.94) :
  156.         - LINELENGTH and COLUMNS options added
  157.  
  158.     AGuideXRef 1.1 (10.5.94) :
  159.         - first beta release
  160.  
  161.